home *** CD-ROM | disk | FTP | other *** search
/ Over 1,000 Windows 95 Programs / Over 1000 Windows 95 Programs (Microforum) (Disc 1).iso / 1263 / html_rtf.doc < prev    next >
Text File  |  1997-04-18  |  6KB  |  127 lines
  1.  
  2.  
  3.  
  4.  
  5.          HTML_RTF.DOC
  6.  
  7.          SOME  REMARKS  ABOUT  THE HTML  AND  RTF  FEATURES  OF  THE SXT
  8.          PROGRAMS
  9.  
  10.          Since the April 95 release all SXT programs can generate output
  11.          in HTML (Hyper Text Markup Language) and RTF (Rich Text Format)
  12.          format  in addition to the default SXT  ASCII output files. The
  13.          HTML  output can be viewed  with WWW Clients  like NCSA Mosaic,
  14.          Netscape  or Lynx and with HTML  add-ons like Microsoft WinWord
  15.          6.0  Internet Assistant. The RTF output can  be used to compile
  16.          MS  Windows Help files  (Windows Help compiler  project file is
  17.          also   generated), but can also be read with any word processor
  18.          which supports the RTF file format. Both output formats support
  19.          the definition  of hypertext anchors and links to allow a quick
  20.          navigation  between  related  topics.  The  SXT  programs  make
  21.          extensive usage of these features to provide different views on
  22.          the  source code analysis  results. The HTML  output is divided
  23.          into four closely related documents to reduce the file size for
  24.          document  loading, the RTF output  is written to  one file. The
  25.          internal  HTML hypertext  links across  files require  that all
  26.          files  are located in the same directory.  This allows that the
  27.          SXT HTML  output results can be viewed from a remote WWW client
  28.          over a network if a WWW server has access to them.
  29.  
  30.          Following are some remarks related to the HTML and RTF features
  31.          of   the  SXT  programs  to  give   the  user  some  additional
  32.          information and help.
  33.  
  34.  
  35.          NETSCAPE 2.0 FRAMES
  36.          Besides  the four HTML  files with call  tree, cross reference,
  37.          name  index  and file  index  information, two  HTML  files are
  38.          generated  which provide additional functionality  based on the
  39.          Netscape  2.0 extensions  for frames  and JavaScript.  The main
  40.          entry  to  the  HTML  output  is  the  file CFTMAIN.HTM  (resp.
  41.          CSTMAIN.HTM,  DFTMAIN.HTM,  ...) which  opens  via CFTFRAME.HTM
  42.          three   frames,   one   frame   with   an  alphabetical   index
  43.          (CFTCONT.HTM),  one as  the main display  window and  the third
  44.          (CFTNAVIG.HTM)  with buttons  to  select the  information being
  45.          displayed.
  46.  
  47.  
  48.          HTML FILENAMES
  49.          The  HTML filename links  inside the  HTML files  have the file
  50.          extension  '.HTM' and are  written in  uppercase letters. Using
  51.          '.HTM' rather than '.HTML' avoids problems when files are moved
  52.          between  DOS and other  file systems  like Windows  NT or OS/2.
  53.          Netscape  and other popular browsers are able  to use both HTML
  54.          file extensions.
  55.  
  56.  
  57.          VIEWING HTML FILES WITH NCSA MOSAIC
  58.          If  the HTML output is  viewed with the WWW  client NCSA Mosaic
  59.          there is a problem with jumps inside a document: such jumps are
  60.          not handled  correct and will usually display a wrong location.
  61.          This  is a problem of  Mosaic which is obviously  no able to do
  62.          such   jumps  inside  locally  stored   and  loaded  documents.
  63.  
  64.                                         1
  65.  
  66.  
  67.  
  68.          Therefore  it is recommended to use the  Netscape WWW client to
  69.          get  best results. This  viewer also requires  less memory than
  70.          Mosaic.
  71.  
  72.  
  73.          UNRESOLVED LINKS
  74.          In  some situations there  are unresolved links  to items which
  75.          will  result in jumps to wrong locations  (HTML) or in an error
  76.          message (RTF  Windows Help). This happens if only a part of the
  77.          source  code is analyzed or if not  all items are listed in the
  78.          output,  e.g. because options  like -a  -u are  missing or only
  79.          selected items are displayed (options -S -Q).
  80.  
  81.  
  82.          ERROR  MESSAGES DURING  COMPILATION OF  RTF FILES  WITH WINDOWS
  83.          HELP COMPILER
  84.          While  compiling  RTF files  to  Windows Help  files  there are
  85.          sometimes  error  messages  like  'context  string ...  already
  86.          used'. This is normal behaviour because there are references to
  87.          items which are not resolved.
  88.  
  89.  
  90.          ITEM FORMAT IN THE HTML AND RTF SXT OUTPUT
  91.          The  output format of the items (functions,  data types) is the
  92.          same as in the ASCII listing.
  93.  
  94.          - Each  item is defined by  its name, its  type (if available),
  95.            followed  by a  unique  identifier, status  information, file
  96.            location and line number:
  97.  
  98.          int main()  (1) <D> <test.c, 12>
  99.                       ^        ^
  100.            The  identifier and the file  name (marked with  ^) are hyper
  101.            text links to the cross reference table resp. file table.
  102.  
  103.          - If  an already  referenced item is  displayed again  then the
  104.            item  name   itself  is  a  hyper  text  link  to  the  first
  105.            definition.
  106.  
  107.          - The  cross reference  table contains  for each  calling resp.
  108.            called  item the number of  calls to / from  it. The item for
  109.            which  the specific relations are  shown displays the summary
  110.            in the format <# calls to, # calls from>.
  111.  
  112.          - The HTML file "progNAMES.HTM" (prog = CFT, CST, ...) contains
  113.            a lexicographical  sorted list of all items with links to the
  114.            item  definition,  the  cross reference  table  and  the file
  115.            table.  For RTF generated Windows help  files a quite similar
  116.            sorted list can be found via the 'Search' button.
  117.  
  118.  
  119.  
  120.          Copyright (C) Juergen Mueller (J.M.) 1988-1996.
  121.          All rights reserved world-wide.
  122.  
  123.          SXT (TM) SOFTWARE EXPLORATION TOOLS
  124.          SXTWIN (TM) SOFTWARE EXPLORATION TOOLS for Windows
  125.  
  126.  
  127.                                         2